

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Iterator Component &mdash; MNMLSTC Core 1.1 documentation</title>
  

  
  

  
  <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  
    <link rel="top" title="MNMLSTC Core 1.1 documentation" href="index.html"/>
        <link rel="next" title="Optional Component" href="optional.html"/>
        <link rel="prev" title="Algorithm Component" href="algorithm.html"/> 

  
  <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-nav-search">
        <a href="index.html" class="fa fa-home"> MNMLSTC Core</a>
        <div role="search">
  <form id ="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
        
        
            <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="usage.html">Using MNMLSTC Core</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#library-layout">Library Layout</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#feature-addition-and-deprecation">Feature Addition and Deprecation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="type-traits.html">Type Traits</a></li>
<li class="toctree-l1"><a class="reference internal" href="functional.html">Functional Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="algorithm.html">Algorithms</a><ul>
<li class="toctree-l2"><a class="reference internal" href="algorithm.html#non-modifying-sequence-operations">Non-Modifying Sequence Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="algorithm.html#modifying-sequence-operations">Modifying Sequence Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="algorithm.html#partitioning-operations">Partitioning Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="algorithm.html#sorting-operations">Sorting Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="algorithm.html#binary-search-operations">Binary Search Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="algorithm.html#set-operations">Set Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="algorithm.html#heap-operations">Heap Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="algorithm.html#min-max-operations">Min/Max Operations</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Iterator Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="optional.html">Optional Types</a><ul>
<li class="toctree-l2"><a class="reference internal" href="optional.html#optional-type">Optional Type</a></li>
<li class="toctree-l2"><a class="reference internal" href="optional.html#expected-type">Expected Type</a></li>
<li class="toctree-l2"><a class="reference internal" href="optional.html#result-type">Result Type</a></li>
<li class="toctree-l2"><a class="reference internal" href="optional.html#functions">Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="optional.html#specializations">Specializations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="numeric.html">Numeric Algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="variant.html">Variant Type</a><ul>
<li class="toctree-l2"><a class="reference internal" href="variant.html#specializations">Specializations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="utility.html">Uncategorized Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="memory.html">Memory</a><ul>
<li class="toctree-l2"><a class="reference internal" href="memory.html#polymorphic-smart-pointer">Polymorphic Smart Pointer</a></li>
<li class="toctree-l2"><a class="reference internal" href="memory.html#deep-copying-smart-pointer">Deep Copying Smart Pointer</a></li>
<li class="toctree-l2"><a class="reference internal" href="memory.html#dumbest-smart-pointer">Dumbest Smart Pointer</a></li>
<li class="toctree-l2"><a class="reference internal" href="memory.html#utilities">Utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="memory.html#comparison-operators">Comparison Operators</a></li>
<li class="toctree-l2"><a class="reference internal" href="memory.html#make-functions">Make Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="memory.html#specializations">Specializations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="string.html">String Utilities</a><ul>
<li class="toctree-l2"><a class="reference internal" href="string.html#specializations">Specializations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="range.html">Range Type</a><ul>
<li class="toctree-l2"><a class="reference internal" href="range.html#specialization">Specialization</a></li>
<li class="toctree-l2"><a class="reference internal" href="range.html#answers-to-open-questions">Answers to Open Questions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="any.html">Any Type</a></li>
</ul>

        
      </div>
      &nbsp;
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="index.html">MNMLSTC Core</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="index.html">Docs</a> &raquo;</li>
      
    <li>Iterator Component</li>
      <li class="wy-breadcrumbs-aside">
        
          <a href="_sources/iterator.txt" rel="nofollow"> View page source</a>
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main">
            
  <div class="section" id="iterator-component">
<span id="core-iterator-component"></span><h1>Iterator Component<a class="headerlink" href="#iterator-component" title="Permalink to this headline">¶</a></h1>
<p>The iterator component provides the additional functions provided in C++14 with
respect to iterators. Specifically the free form functions that work like
<tt class="docutils literal"><span class="pre">std::begin</span></tt> and <tt class="docutils literal"><span class="pre">std::end</span></tt>.</p>
<dl class="function">
<dt id="size__ContainerCRCE">
<em class="property">constexpr</em> auto <tt class="descname">size</tt><big>(</big>Container const&amp; <em>container</em><big>)</big><tt class="descclassname"> noexcept</tt><a class="headerlink" href="#size__ContainerCRCE" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><tt class="docutils literal"><span class="pre">container.size()</span></tt> or <tt class="docutils literal"><span class="pre">N</span></tt> if <em>container</em> is an array.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="empty__ContainerCRCE">
<em class="property">constexpr</em> auto <tt class="descname">empty</tt><big>(</big>Container const&amp; <em>container</em><big>)</big><tt class="descclassname"> noexcept</tt><a class="headerlink" href="#empty__ContainerCRCE" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><tt class="docutils literal"><span class="pre">container.empty()</span></tt> or <tt class="docutils literal"><span class="pre">false</span></tt> if <em>container</em> is an array.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="front__ContainerCRCE">
<em class="property">constexpr</em> auto <tt class="descname">front</tt><big>(</big>Container const&amp; <em>container</em><big>)</big><a class="headerlink" href="#front__ContainerCRCE" title="Permalink to this definition">¶</a></dt>
<dt id="front__ContainerRCE">
<em class="property">constexpr</em> auto <tt class="descname">front</tt><big>(</big>Container&amp; <em>container</em><big>)</big><a class="headerlink" href="#front__ContainerRCE" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><tt class="docutils literal"><span class="pre">container.front()</span></tt> or <tt class="docutils literal"><span class="pre">container[0]</span></tt> if <em>container</em> is an
array.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="back__ContainerCRCE">
<em class="property">constexpr</em> auto <tt class="descname">back</tt><big>(</big>Container const&amp; <em>container</em><big>)</big><a class="headerlink" href="#back__ContainerCRCE" title="Permalink to this definition">¶</a></dt>
<dt id="back__XCE">
<em class="property">constexpr</em> auto <tt class="descname">back</tt><big>(</big><em>Container&amp;</em><big>)</big><a class="headerlink" href="#back__XCE" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><tt class="docutils literal"><span class="pre">container.back()</span></tt> or <tt class="docutils literal"><span class="pre">container[N</span> <span class="pre">-</span> <span class="pre">1]</span></tt> if <em>container</em> is
an array.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="data__ContainerCRCE">
<em class="property">constexpr</em> auto <tt class="descname">data</tt><big>(</big>Container const&amp; <em>container</em><big>)</big><tt class="descclassname"> noexcept</tt><a class="headerlink" href="#data__ContainerCRCE" title="Permalink to this definition">¶</a></dt>
<dt id="data__ContainerRCE">
<em class="property">constexpr</em> auto <tt class="descname">data</tt><big>(</big>Container&amp; <em>container</em><big>)</big><tt class="descclassname"> noexcept</tt><a class="headerlink" href="#data__ContainerRCE" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><tt class="docutils literal"><span class="pre">container.data()</span></tt> or <tt class="docutils literal"><span class="pre">container</span></tt> if <em>container</em> is an array.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="cbegin__ContainerCR">
 <tt class="descname">cbegin</tt><big>(</big>Container const&amp; <em>container</em><big>)</big><a class="headerlink" href="#cbegin__ContainerCR" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><tt class="docutils literal"><span class="pre">std::begin(container)</span></tt></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="cend__ContainerCR">
 <tt class="descname">cend</tt><big>(</big>Container const&amp; <em>container</em><big>)</big><a class="headerlink" href="#cend__ContainerCR" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><tt class="docutils literal"><span class="pre">std::end(container)</span></tt></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="rbegin__ContainerCR">
 <tt class="descname">rbegin</tt><big>(</big>Container const&amp; <em>container</em><big>)</big><a class="headerlink" href="#rbegin__ContainerCR" title="Permalink to this definition">¶</a></dt>
<dt id="rbegin__ContainerR">
 <tt class="descname">rbegin</tt><big>(</big>Container&amp; <em>container</em><big>)</big><a class="headerlink" href="#rbegin__ContainerR" title="Permalink to this definition">¶</a></dt>
<dd><p>Requires that the given <em>container</em> have a member function named <tt class="docutils literal"><span class="pre">rbegin</span></tt>.
If no such member function exists, the function will fail to compile.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><tt class="docutils literal"><span class="pre">container.rbegin()</span></tt></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="crbegin__ContainerCR">
 <tt class="descname">crbegin</tt><big>(</big>Container const&amp; <em>container</em><big>)</big><a class="headerlink" href="#crbegin__ContainerCR" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><tt class="docutils literal"><span class="pre">rbegin(container)</span></tt></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="rend__ContainerCR">
 <tt class="descname">rend</tt><big>(</big>Container const&amp; <em>container</em><big>)</big><a class="headerlink" href="#rend__ContainerCR" title="Permalink to this definition">¶</a></dt>
<dt id="rend__ContainerR">
 <tt class="descname">rend</tt><big>(</big>Container&amp; <em>container</em><big>)</big><a class="headerlink" href="#rend__ContainerR" title="Permalink to this definition">¶</a></dt>
<dd><p>Requires that the given <em>container</em> have a member function named <tt class="docutils literal"><span class="pre">rend</span></tt>.
If no such member function exists, the function will fail to compile.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><tt class="docutils literal"><span class="pre">container.rend()</span></tt></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="crend__ContainerCR">
 <tt class="descname">crend</tt><big>(</big>Container const&amp; <em>container</em><big>)</big><a class="headerlink" href="#crend__ContainerCR" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><tt class="docutils literal"><span class="pre">rend(container)</span></tt></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="class">
<dt id="infix_ostream_iterator:T:">
<em class="property">class </em><tt class="descname">infix_ostream_iterator&lt;T&gt;</tt><a class="headerlink" href="#infix_ostream_iterator:T:" title="Permalink to this definition">¶</a></dt>
<dd><p>The <a class="reference internal" href="#infix_ostream_iterator:T:" title="infix_ostream_iterator&lt;T&gt;"><tt class="xref cpp cpp-class docutils literal"><span class="pre">infix_ostream_iterator&lt;T&gt;</span></tt></a> is used as a replacement for
<tt class="docutils literal"><span class="pre">std::ostream_iterator</span></tt>, where the delimiter is not desired for the last
element. This iterator comes in use when one might wish to print a list.</p>
</dd></dl>

</div>


          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="optional.html" class="btn btn-neutral float-right" title="Optional Component"/>Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="algorithm.html" class="btn btn-neutral" title="Algorithm Component"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2013 - 2014, MNMLSTC.
    </p>
  </div>

  <a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>
</footer>
        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'1.1',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="_static/jquery.js"></script>
      <script type="text/javascript" src="_static/underscore.js"></script>
      <script type="text/javascript" src="_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>